ListMultipartUploads
Description
ListMultipartUploads can list all Multipart Upload events in execution, that is, Multipart Upload events that have been initialized but not Complete or Multipart Upload events of Abort.
Request Method
POST
Request Path
/apsara/route/OneRouter/ListMultipartUploads
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| max-uploads | BODY | string | No | 1000 | limits the maximum number of Multipart Uploads events returned this time. if not set, the default value is 1000, and the max-uploads value cannot be greater than 1000. type: string |
| encoding-type | BODY | string | No | utf-8 | specifies to encode the returned content and specify the type of encoding. Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key use UTF-8 characters, but the XML1.0 standard does not support parsing some control characters, such as characters with ASCII values ranging from 0 to 10. For control characters that contain control characters not supported by XML 1.0 standards, you can encode the returned Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key by specifying encoding-type. Default value: None |
| upload-id-marker | BODY | string | No | None | is used with the key-marker parameter to specify the starting position of the returned result. If the key-marker parameter is not set, OSS ignores the upload-id-marker parameter. if the key-marker parameter is set, the query result includes: all Multipart events whose lexicography order is greater than the key-marker parameter value and the object name is equal to the key-marker parameter value, but the Upload ID is larger than the upload-id-marker parameter value Multipart Uploads events. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| delimiter | BODY | string | No | None | is a character used to group Object names. All names contain the specified prefix and Object between the first occurrence of delimiter characters is a set of elements (I. e. CommonPrefixes). |
| prefix | BODY | string | No | None | The returned Object key must be prefixed with prefix. Note that when using prefix query, the returned key still contains prefix. |
| key-marker | BODY | string | No | None | is used with upload-id-marker parameters to specify the starting position of the returned result. if the upload-id-marker parameter is not set, the query result includes Multipart events where the lexicographic order of all object names is greater than the key-marker parameter value. if the upload-id-marker parameter is set, the query result includes: all Multipart events whose lexicography order is greater than the key-marker parameter value and the object name is equal to the key-marker parameter value, but the Upload ID is larger than the upload-id-marker parameter value Multipart Uploads event. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| UploadIdMarker | string | None | the starting UploadID position of the list. |
| NextKeyMarker | string | oss.avi | if all results are not returned this time, the response request will contain NextKeyMarker elements to indicate the KeyMarker value of the next request. |
| MaxUploads | integer | 1000 | The maximum number of Uploads returned. |
| EncodingType | string | UTF-8 | indicates the type of encoding used in the returned result. If encoding-type is specified in the request parameter, the returned result encodes elements such as Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key. |
| Upload | container | not involved | container that holds Multipart Upload event information. |
| IsTruncated | enumeration string | false | indicates whether the list of Multipart Upload results returned this time is truncated. true indicates that all results have not been returned this time. false indicates that all results have been returned this time. valid values: false, true default value: false |
| ListMultipartUploadsResult | container | not involved | the container that holds the results of the List Multipart Upload request. |
| UploadId | string | 0004B999EF518A1FE585B0C9360DC4C8 | Multipart the ID of the Upload event. |
| Initiated | date | 2012-02-23T04:18:23.000Z | Multipart the initialization time of the Upload event. |
| NextUploadMarker | string | 0004B99B8E707874FC2D692FA5D77D3F | if all results are not returned this time, the response request will contain NextUploadMarker elements to indicate the UploadMarker value of the next request. |
| Bucket | string | oss-example | Bucket name. |
| Key | string | multipart.data | initializes the object name of the Multipart Upload event. |
| KeyMarker | string | 5 | The starting object position of the list. |
Example
Successful Response example
{
"UploadIdMarker":"None",
"NextKeyMarker":"oss.avi",
"MaxUploads":"1000",
"EncodingType":"UTF-8",
"Upload":"not involved",
"IsTruncated":"false",
"ListMultipartUploadsResult":"not involved",
"UploadId":"0004B999EF518A1FE585B0C9360DC4C8",
"Initiated":"2012-02-23T04:18:23.000Z",
"NextUploadMarker":"0004B99B8E707874FC2D692FA5D77D3F",
"Bucket":"oss-example",
"Key":"multipart.data",
"KeyMarker":"5"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}